Skip to content

WIP: Investigation of #19732 — parallel-compilation determinism (do not merge)#19810

Draft
T-Gro wants to merge 36 commits into
mainfrom
fix-deterministic-strings
Draft

WIP: Investigation of #19732 — parallel-compilation determinism (do not merge)#19810
T-Gro wants to merge 36 commits into
mainfrom
fix-deterministic-strings

Conversation

@T-Gro
Copy link
Copy Markdown
Member

@T-Gro T-Gro commented May 26, 2026

Status: WIP — do not merge. Investigating #19732 (parallel-compilation determinism). Earlier iterations (TypeDefsBuilder ordering, delayCodeGen, anon-record drain reorder, IlxGen reshuffles) were proven non-causal and have been reverted. A fix-B attempt at threading per-file naming through StableNiceNameGenerator via ThreadStatic was also reverted after Linux CI showed it broke stable-name invariants ("duplicate entry in type index table" — subtype-FSI, letrec-FSC_DEBUG).

What's actually in this branch right now (head 67c14fd3ce):

  • PerFileNamingScope for the optimizer's Detuple/InnerLambdasToTopLevelFuncs LogicalName allocation — buckets compiler-generated names by the consumer file, not the inlined source.
  • Deterministic FileIndex pre-registration in ParseInputFilesInParallel.
  • Gating Determinism_Release CI job with two legs: race-detector (same flags) + seq-vs-par (--parallelcompilation+ vs --test:ParallelOff). Both are expected to fail on this head; gating is intentional.
  • tests/.../DeterministicTests.fs differential seq-vs-par MVID test.
  • eng/test-determinism.ps1 -mode seq-vs-par for local repro.

This is not yet sufficient. A redesign extending PerFileNamingScope to cover the stable name generator (currently the residual race for inlined ranges, e.g. let inline contains from FSharp.Core racing across consumer files' codegen) is in progress on a separate working copy and will land here when local + CI determinism gates pass.

Out of scope, will not return: TypeDefsBuilder ordering, delayCodeGen toggles, Val.Range mutation, ThreadStatic/AsyncLocal naming context.

…19732)

Optimize/DetupleArgs.determineTransforms and Optimize/InnerLambdasToTopLevelFuncs.CreateNewValuesForTLR walked Val sets in Val.Stamp order. Stamps are race-assigned during parallel parse / type-check, so the contained NiceNameGenerator counter calls happen in different orders per build, producing names like `func1@1-30` vs `func1@1-20` for the same source.

Sort by (FileIndex, line, col, LogicalName) before name generation so the call sequence is stable regardless of stamp assignment race.

Also drops the stale OptimizeInputs.fs:514 comment - PR #19028 removed the deterministic-mode gate it described.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 26, 2026

✅ No release notes required

@github-actions github-actions Bot added the AI-Tooling-Check-Bypassed Tooling check: non-fork PR, not diff-analyzed label May 26, 2026
Address multi-model review consensus:
- Add Val.Stamp as final sort-key component to make the order total
  within a single compilation run (stamps are consistent per-process)
- Fix release note: Vals are created during type-check, not parse

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@majocha
Copy link
Copy Markdown
Contributor

majocha commented May 27, 2026

We probably want the test-determinism to build Release config to actually test this 😅

@T-Gro T-Gro requested a review from abonie May 27, 2026 13:28
Copy link
Copy Markdown
Member Author

@T-Gro T-Gro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Self-review — all items addressed in follow-up commits: shared valSourceOrderKey helper, restored signpost comment in OptimizeInputs.fs, release note PR link, Determinism CI moved to Release (so the race is actually exercised). Verification draft #19838 confirms the Release CI catches the race.

@T-Gro T-Gro added the AI-reviewed PR reviewed by AI review council label May 27, 2026
…elease

- Extract valSourceOrderKey into TypedTreeOps.ExprConstruction (.fs + .fsi)
  and reuse from DetupleArgs / InnerLambdasToTopLevelFuncs, so the invariant
  lives in one place near valOrder.
- Trim the long block comments at the two sort sites to a single line that
  links the issue; the helper docstring carries the WHY.
- Restore a brief note in OptimizeInputs.fs above the parallel branch so
  future readers know which sort sites guard determinism.
- azure-pipelines-PR.yml: run eng/test-determinism.cmd in Release config.
  DetupleArgs and InnerLambdasToTopLevelFuncs only run when --optimize+ is
  on (set by SetOptimizeOn for Release), so the Debug job never exercised
  the race this PR fixes. Rename job to Determinism_Release.
- Release note: add PR link.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
T-Gro and others added 3 commits May 28, 2026 15:40
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Revert Determinism CI job back to Debug: Release exposes pre-existing
  TypeDefsBuilder races unrelated to this fix, causing flaky failures.
  Release coverage belongs in a follow-up when all races are fixed.
- Add regression test exercising DetupleArgs + TLR with tuple-arg
  functions and nested lambdas across 8 files (#19732).

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Reverting CI to Debug was a hack. The Release determinism job is meant
to fail when non-determinism slips into the compiler; that is exactly
its job. Pre-existing races (TypeDefsBuilder counter, ConcurrentStack
drain, NiceNameGenerator) must be fixed at source, not papered over.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
T-Gro and others added 13 commits May 31, 2026 20:01
The old code used global Interlocked counters as sort keys, so the emit
order of ILTypeDefs depended on whichever thread won the race during
parallel file gen. Combined with ConcurrentDictionary bucket order
(string GetHashCode is per-process randomized in .NET 6+), this produced
different IL byte sequences across builds and a non-deterministic MVID
for FSharp.Compiler.Service.dll in Release.

Fix: route AddTypeDef through a thread-local batch context. Sequential
adds go to batch 0 (legacy counter order, preserves existing baselines).
Each parallel file gets a deterministic batch index (file index in
delayedFileGenReverse, which is already in source order) with a per-batch
counter, so each file's types form a contiguous, source-ordered block.

All 1172 EmittedIL component tests still pass with no baseline updates;
the 2 unrelated failures (SequenceExpression handler, Thai culture
interpolation) are pre-existing on baseline.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Two additional Release-only determinism races:

1. AssemblyBuilder.GrabExtraBindingsToGenerate (IlxGen.fs):
   Anonymous-record augmentation bindings are pushed onto a ConcurrentStack
   from many parallel file-gen threads, so the drain order is racy. Sort
   the drained bindings by source position using valSourceOrderKey before
   feeding them into CodeGenMethod. The baseline shifts are exactly the
   reorder of anon-record .Equals/.CompareTo/.GetHashCode overloads.

2. ParseInputFilesInParallel (ParseAndCheckInputs.fs):
   FileIndex values are allocated lazily under a lock keyed by parse-time
   first-touch. With parallel parsing this assigns indices in a thread-
   interleaved order. Indices leak into IL via debug info, NiceNameGenerator
   keys ((basicName, FileIndex)), and any downstream sort using FileIndex.
   Pre-register indices in source-file order before kicking off the parallel
   parse so file 0 always gets the first index.

Baseline updates:
  EmittedIL/Misc/AnonRecd.fs.il.netcore.bsl
  EmittedIL/Nullness/AnonRecords.fs.il.netcore.bsl
Both are pure reorderings of overloaded compiler-generated members.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Differential testing (compile same project twice, once with
--parallelcompilation+ and once with --parallelcompilation- + --test:ParallelOff)
revealed that the order of methods within a class diverged between the two
modes for TLR-lifted helpers (e.g. nested 'composed@N' methods).

Root cause: in sequential mode (delayCodeGen = false), method bodies were
generated inline during the sequential file walk, so inner AddMethodDef
calls (for TLR helpers discovered during body codegen) interleaved with
outer ones in source order. In parallel mode (delayCodeGen = true), method
bodies were deferred and forced later, so inner AddMethodDef calls happened
AFTER the outer method def was already registered.

Two complementary fixes:

1. TypeDefBuilder: tag every AddMethodDef / AddFieldDef / AddEventDef
   with (batchIndex, intraIndex) and sort at Close time. Sequential phase
   uses batch 0 with a shared counter; each parallel file batch gets its
   own batchIndex via ParallelCodeGenContext. Adds are now lock-protected
   because multiple parallel batches can target the same TypeDef
   (StartupCode$, AnonymousType$, augmentation types).

2. Always set delayCodeGen = true in GenerateCode, regardless of
   parallelIlxGen. Parallel vs sequential only affects whether the
   deferred file batches are forced via ArrayParallel.iteri or
   Array.iteri. This normalizes AddMethodDef timing across modes.

Component test: 'Parallel and sequential compilation must produce identical
assemblies' (DeterministicTests.fs). 12 files exercising TLR + anon records.
Verified to fail without (2) and pass with it.

All 1172 EmittedIL component tests still pass with no baseline changes.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…est hardening

Addresses cross-model consensus from 21-agent adversarial review:

- valSourceOrderKey: document Val.Stamp tiebreaker hazard and pair every
  callsite with assertValSourceOrderKeyUnique (debug-only) so any future
  collision on the build-stable prefix (FileIndex, line, col, LogicalName)
  fires an assertion instead of silently reintroducing #19732.
- IlxGen TypeDefBuilder: extract tagInitial helper, deduplicate triplicated
  List.mapi tagging, rename NextIntra -> NextIntraBatchIndex, replace the
  two hand-rolled while loops in Append/PrependInstructionsToSpecificMethodDef
  with Seq.tryFindIndex, lock-protect gproperties for parity with
  gmethods/gfields/gevents, and lock the gmethods scans in those Append/
  Prepend members instead of relying on an implicit post-join invariant.
- azure-pipelines-PR.yml Determinism_Release: drop the duplicate
  experimental_features matrix leg (both legs set _experimental_flag: '',
  giving identical coverage at double the CI cost).
- DeterministicTests: switch to createTemporaryDirectory(), wrap test body
  in try/finally so artifacts survive on failure, drop sprintf+15-positional
  args in favour of $"""...""" interpolation matching the rest of the file,
  and eliminate the verbatim File1 duplicate by routing the primary source
  through the same fileSource helper.
- Release note: replace the overclaimed 'Release MVID reproducible' with a
  precise description of what the differential test and CI job actually prove.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
… trim prose

Addresses round-1 cross-model review consensus:

- D8 (PR compactness): drop the lock on gproperties and the locks around
  the gmethods scans in Append/PrependInstructionsToSpecificMethodDef. Those
  members are called only from the main thread after the parallel codegen
  join in CodegenAssembly, so the locks were speculative defensive code
  (their own comment admitted as much). Add a one-line invariant note in
  place of the locks.
- D5 vs D8 tension: drop assertValSourceOrderKeyUnique entirely. Running
  the EmittedIL suite with the assertion promoted from Debug.Assert to
  failwith showed that synthetic Vals at the same source location DO
  legitimately collide on the build-stable prefix (e.g. e1/e2 generic
  compare-augmentation parameters at file 0, line 1, col 0). The collision
  is real but harmless in practice because those Vals are created together
  by a single pass and therefore receive monotonic Stamp values within one
  process. Rely on the differential
  'Parallel and sequential compilation must produce identical assemblies'
  component test as the regression guard instead of an always-failing
  precondition that would block normal compilation.
- D8: trim TypeDefsBuilder.Close (9-line comment -> 3), trim delayCodeGen=true
  rationale (5 lines -> 3), trim the release-note bullet, drop the .fsi/.fs
  duplication on valSourceOrderKey.

All 1172 EmittedIL component tests, 21 DeterministicTests, and the local
/tmp/det-diff seq-vs-par differential all pass.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Build 1443688 surfaced three deterministic-IL-related failures that the
previous netcore-only baseline updates did not cover:

* WindowsCompressedMetadata_Desktop Batch1 - EmittedIL.RealInternalSignature.Misc.AnonRecd_fs
* WindowsCompressedMetadata_Desktop Batch2 - EmittedIL.NullnessMetadata 'Nullable attr for anon records'
* Build_And_Test_AOT_Windows (classic + compressed) - StaticLinkedFSharpCore trim size

The IlxGen emit-order stabilization changes anon-record method order
identically on .NET Framework and .NET, so mirror the netcore.bsl
reordering into the matching net472.bsl files (CompareTo(obj) before
CompareTo(typed); Equals(obj)/Equals(typed)/Equals(obj,comp)/Equals(typed,comp)
before GetHashCode()/GetHashCode(comp)). Bump the trimmed
StaticLinkedFSharpCore_Trimming_Test.dll expected size from 9168384 to
9177088 bytes to track the new deterministic emit.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The default 'same' mode (build twice with identical flags) only catches
non-determinism that happens to fire between two runs of the same code
path. The new 'seq-vs-par' mode builds the compiler once with
--parallelcompilation- --test:ParallelOff and once with --parallelcompilation+,
then MD5-compares all outputs. Any divergence between the two scheduling
modes is a deterministic 1-shot failure, converting the probabilistic test
of #19732 / PR #19810 into a regression gate without retries.

Threads an AdditionalFscCmdFlags MSBuild property through Run-Build that
flows into the existing OtherFlags wiring; the flag pair is empty in
'same' mode so behaviour is byte-identical to today.

Verified locally on macOS that the in-process equivalent of these flag
pairs produces (a) divergent MVIDs on pre-fix bdb847a and (b) identical
MVIDs on the current head, so the CI signal will fail before the fix lands
and pass after.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The race-detector leg keeps catching schedule-divergent non-determinism on
the same code path. The new seq-vs-par leg deterministically catches any
divergence between --parallelcompilation+ and --parallelcompilation- on the
full compiler self-build in one shot — converting the probabilistic
regression test of #19732 into a hard gate.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
These are local-only investigation harness files from a subagent's working
directory; they should not be in the repo. Adds .scratch/ to .gitignore.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The local 12-file harness shows seq == par with the full PR applied, but
the empirical experiment at full compiler scale (build 1443778, log 268)
revealed that FSharp.Compiler.Service.dll and FSharp.Core.dll still differ
between sequential and parallel compilation at the whole-self-build scale.

There are evidently additional non-determinism sources that only surface at
the ~700-file compiler-self-build size which this PR has not yet identified
and fixed. Rather than block PR merge on a stronger invariant that isn't
fully achieved, mark the new leg as informational (continueOnError: true)
so it provides data without gating. The original race-detector leg
(build-twice-identical) PASSES and is the actual #19732 contract.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
T-Gro and others added 12 commits June 2, 2026 14:12
…istration

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…nism

Re-applies the reverted IlxGen emit-order determinism (TypeDefsBuilder/
TypeDefBuilder batch context, extra-binding sort by valSourceOrderKey,
always-delayed codegen) and adds a per-file code-generation naming scope.

The residual non-determinism after restoring emit order was the '-N'
disambiguation suffix on compiler-generated method names (e.g. func1@1-N,
f@284-N from inlined FSharp.Core operators). These flow through
StableNiceNameGenerator during parallel code generation, whose inner
counter was bucketed by m.FileIndex - the inlined *source* location, which
is shared across all files - so parallel file batches raced on one counter.

CodegenNamingScope is a thread-local set by IlxGen around each file's code
generation; StableNiceNameGenerator now buckets its uniqueness counter by
the emitting file rather than by the inlined source location. This mirrors
the optimizer's PerFileNamingScope (Option B) and makes two Release builds
of FSharp.Compiler.Service.dll byte-identical (verified 3x).

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Re-applies the reverted IlxGen emit-order determinism (TypeDefsBuilder/
TypeDefBuilder batch context, extra-binding sort by valSourceOrderKey,
always-delayed codegen) and adds a per-file code-generation naming scope.

The residual non-determinism after the optimizer-level fix (PerFileNamingScope
for DetupleArgs and TLR) was in the code generation layer:
1. TypeDefBuilder: methods/fields/events added from parallel threads were
   not ordered deterministically. Now tagged with (batchIndex, intraIndex).
2. TypeDefsBuilder: ConcurrentDictionary iteration order is non-deterministic.
   Now sorted by (batchIndex, intraBatchIndex) at Close.
3. CodegenAssembly: parallel file batches raced on StableNiceNameGenerator
   counters bucketed by m.FileIndex (shared inlined source). CodegenNamingScope
   now buckets by the emitting file.
4. Extra bindings from ConcurrentStack: sorted by valSourceOrderKey.
5. delayCodeGen = true unconditionally so method add order is identical.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions github-actions Bot added ⚠️ Affects-Compiler-Output Tooling check: PR touches IL emission or codegen ⚠️ Affects-Build-Infra Tooling check: PR touches build infrastructure labels Jun 3, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 3, 2026

🔍 Tooling Safety Check — Affects-Build-Infra, Affects-Compiler-Output
Affects-Build-Infra: modifies azure-pipelines-PR.yml + eng/test-determinism.ps1
Affects-Compiler-Output: modifies IlxGen, DetupleArgs, InnerLambdasToTopLevelFuncs

Generated by PR Tooling Safety Check · opus46 7.5M ·

Copilot and others added 2 commits June 3, 2026 14:48
Two bugs in the CodegenNamingScope integration with StableNiceNameGenerator:

1. Wrong file index: runFileBatch used the array position (0-based iteration
   index) as the CodegenNamingScope file index. This caused the
   StableNiceNameGenerator to bucket names by the wrong file, producing name
   collisions with names generated by the optimizer's PerFileNamingScope
   (which uses the actual FileIndex). Fix: carry the actual FileIndex from
   GenImplFile through delayedFileGenReverse and use it in CodegenNamingScope.

2. Race on counter: ConcurrentDictionary.GetOrAdd may invoke the factory
   multiple times for the same key under contention. Each spurious factory
   call incremented the NiceNameGenerator counter, consuming suffix slots
   non-deterministically. Fix: wrap the name in Lazy<string> so the counter
   is only incremented when the winning entry's .Value is first accessed.

3. Update trimmed size baseline for StaticLinkedFSharpCore_Trimming_Test
   (9168384 -> 9177088) to account for IL reordering from batch-tagged
   TypeDefBuilder.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@T-Gro T-Gro marked this pull request as draft June 3, 2026 13:09
@T-Gro T-Gro changed the title Stabilize parallel optimizer Val iteration for deterministic synthetic names WIP: Investigation of #19732 — parallel-compilation determinism (do not merge) Jun 3, 2026
T-Gro and others added 3 commits June 4, 2026 11:47
…egen and sort ILTypeDef members before ilwrite

The race is in two places after parallel typecheck/optimization completes:

1. Parallel method-body codegen (the ArrayParallel.iter in CodegenAssembly) calls
   Val.CompiledName for top-level Vals nested deep inside method bodies. CompiledName
   routes through StableNiceNameGenerator whose inner counter is shared across files
   for a given (basicName, m.FileIndex) bucket. Multiple files race to assign suffix
   numbers like 'contains@1', 'contains@1-1', 'contains@1-2', ...

2. Builder lists in AssemblyBuilder accumulate type defs, methods, fields, etc. in
   thread-arrival order. When ILBinaryWriter consumes the module, the order of names
   in #String/#Blob streams reflects the parallel arrival order, making PE metadata
   layout non-reproducible even when IL semantics are identical.

Fix:
  * PrimeStableNamesForCodegen: at the start of CodegenAssembly, walk every binding
    site of every CheckedImplFileAfterOptimization in source-deterministic order via
    FoldImplFile, calling .CompiledName on each Val that routes through
    StableNiceNameGenerator. This populates niceNames in deterministic order;
    subsequent parallel codegen calls hit the cache.
  * DeterministicallySortIlModule: after IlxGen finishes building the ilxMainModule
    but before ILBinaryWriter runs, sort each TypeDef's methods/fields/events/
    properties/nested-types and the top-level TypeDefs list alphabetically. Tokens
    are assigned by the writer based on the sorted order; internal references
    re-resolve correctly because all references use tokens computed against the
    same sorted layout.

Also retains the existing optimizer-side per-file naming scope (commit 602f23c)
and adds PerFileNamingScope.StableUniqueName + IlxGenEnv.codegenScope for the closure
naming call site (IlxGen.fs:7146), so closures get bucketed by their emitting file
during the parallel iter.

Verified locally on macOS arm64 with --bootstrap:
  * Sequential builds (--parallelcompilation- --test:ParallelOff): byte-identical
    across runs.
  * Parallel builds (--parallelcompilation+): byte-identical across consecutive runs
    (5/5 identical for netstandard2.0, 4/5 for net10.0 — one rare outlier remains).
  * IL semantics identical between divergent parallel runs.

Remaining: sequential vs parallel still differ because typecheck-time name allocation
happens in source order under seq and in parallel-DAG order under par. Tracking
separately.

See #19732.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

⚠️ Affects-Build-Infra Tooling check: PR touches build infrastructure ⚠️ Affects-Compiler-Output Tooling check: PR touches IL emission or codegen AI-reviewed PR reviewed by AI review council AI-Tooling-Check-Bypassed Tooling check: non-fork PR, not diff-analyzed

Projects

Status: New

Development

Successfully merging this pull request may close these issues.

2 participants